功能介绍
开发者可以在云鲸IoT业务平台配置内测产品与Jira项目的推送规则,用于将内测产品的用户反馈信息推送至对应Jira空间,自动创建BUG单。
前置条件
- 您的IoT账号具备相应功能菜单的权限,并至少拥有一个产品的授权。
- 您的Jira账号拥有对应空间“项目设置”权限。
操作流程
本功能涉及到的服务如下:
- 业务平台用户反馈推送:
- 维护不同产品用户反馈推送至对应Jira项目
- 在用户提交反馈时补充IoT平台相关设备信息,并自动提交Bug单
- Jira系统:
用于公司软硬件项目管理,在本需求中负责Jira问题经办人自动流转、钉钉群聊消息通知等
实现反馈信息推送Jira需要进行三个操作:
创建Jira项目
创建Jira
APP反馈表单的渲染规则是:动态拉取对应Jira项目对应Jira项目中问题类型为bug的必填项表单。因此首先需要完成Jira项目创建后才能进行后续操作。
注意:其中部分Jira表单项已被设置为默认不显示,见下表:
除去上表中标注为默认不显示的JiraBug表单字段以外,其余设置为JiraBug表单字段均会显示在APP问题反馈中。
- 如需新增问题字段,请在对应Jira项目中新增该字段,并设置为必填项
- 请将附件设置为非必填项,否则会导致推送异常
(1)按照填写格式完成Jira项目bug表单创建/变更,填写格式参考附件中的模板。
关于更多Jira字段的介绍:https://confluence.atlassian.com/adminjiraserver0820/adding-custom-fields-1095777011.html
(2)将表格提交至 杨提龙(Jira系统负责人),等待项目创建/变更
(3)在完成Jira项目创建/变更后,在Jira项目中添加IoT公共账号“jira@narwal.com"">aiot-jira@narwal.com”,并至少提供给此账号创建BUG单的权限(此处给该账号提供了“测试”身份)
(4)在模块中添加“测试中心”,并填写模块负责人(推荐填写测试PM),并将任务默认分配给模块负责人。
2. 创建推送规则
该操作用于维护反馈信息推送至Jira系统的推送规则。
(1)登录 云鲸IoT平台
(2)在 “业务后台 - 云鲸APP业务管理 - 用户反馈推送 -推送规则” 中点击新建规则按钮。
(3)在弹窗内配置推送规则相关配置项,配置项说明如下
配置项 | 说明 | 示例 |
---|---|---|
规则名称 | 用于对推送规则进行命名,最大32个字符。 | J3 |
关联产品 | 下拉选择平台已创建的产品。指的是推送规则对应的产品。必须唯一,规则创建后无法修改。 | 云鲸J3 |
项目ID | 下拉选择IoT公共账号可访问的Jira项目。指的是反馈信息推送的目标JIRA项目,可以不唯一。规则创建后无法修改。 | 用户反馈教程 |
公共账号 | 默认为“jira@narwal.com"">aiot-jira@narwal.com”,不可修改。 需要检查在规则对应的Jira项目中已添加该账号,并该账号具有创建BUG单的权限 | —— |
(4)点击确定后创建对应规则
3. 创建Jira规则
利用Jira的“project automation”功能,能够实现自动分配经办人、推送钉钉消息。此处以AX6&8内测项目为例,进行Jira自动化规则配置。
(1)在Jira项目界面点击“项目设置”,找到“project automation”
(2)点击“新建规则”
(3)选择规则触发器
触发器是自动化规则启动的条件。在本次教程中选择的触发器是“议题已建立”时。这意味着,无论何时在 Jira 中创建新的问题,自动化规则都会启动。
(4)添加条件
通过设置条件,可以约束规则的适用范围。此处选择的条件是“If/else选项块”。 在项目空间里,除了内测反馈生成的BUG单以外,还会有其他BUG单,因为此需要在规则中增加针对内测反馈的限制。
通过设置“问题类型等于BUG单”,以及“概要中包括【内测反馈】”,能够将规则执行范围锁定为内测反馈中。
(5)增加动作
- 推送钉钉操作
a. 创建钉钉机器人:在钉钉群中,点击群设置-机器人-添加机器人-选择“IoT平台机器人”,点击添加后再点击完成。
b. 复制机器人的webhock地址:点击机器人头像,在弹框中点击机器人设置,确保消息推送处于开启状态,点击复制,拷贝机器人webhock。
c. 在Jira系统中接着上述 步骤(4) 的操作。点击新建动作,接着点击传送网络要求。
d. 在弹出界面中输入配置项,关于配置项的解释如下:
配置项 | 说明 |
---|---|
Webhook URL | 必填,填写内容为 步骤b 中复制的机器人webhock |
HTTP 方法 | 选择POST |
webhook 內文 | 选择自定资料 |
自定资料 | 填写需要推送的内容信息。填写规则如下: 推送内容需要根据钉钉的推送接口规定的格式以及JIRA的一些变量值来填写,可以参考以下两个链接。 钉钉消息格式:https://open.dingtalk.com/document/robots/custom-robot-access#title-72m-8ag-pqw JIRA变量值:https://support.atlassian.com/cloud-automation/docs/smart-values-in-jira-automation/ |
本次演示中,将Jira项目中的“概要”、“描述”、“链接”作为了推送内容,实现方式与结果如下:
自定资料内容 | 钉钉推送结果 |
---|---|
- 指定经办人操作
a. 在Jira系统中接着上述 步骤(4) 的操作。点击新建动作,接着点击编辑议题,在“选择要设定的栏位”中选择“经办人”、“报告人”,并在下方填写对应问题分类的经办人、报告人。
(5)完成规则校验并启用。
在完成条件添加后,填写规则名称并点击“将其开放”,请保证规则处于已启用状态。
最后编辑:陈勇琦 更新时间:2024-10-18 16:29